[QuickLook] Update bindings for Xcode 13.0 beta 1,2,3,4 #12337

rachelkang · 2021-08-03T20:40:44Z

Updates to this PR do not include updates relevant to QuickLookThumbnailing, QuickLookUI

Generator fix courtesy of @spouliot

[QuickLook] QLPreviewSceneActivationConfiguration not yet bound in Xcode13

rachelkang · 2021-08-03T20:42:37Z

src/quicklook.cs

+ nint InitialPreviewIndex { get; set; }
+ }
+
+ // TODO: BaseType UIWindowSceneActivationConfiguration must first be implemented in UIKit


[QuickLook] QLPreviewSceneActivationConfiguration not yet bound in Xcode13 because base type UIWindowSceneActivationConfiguration is not yet bound in UIKit

src/quicklook.cs

spouliot · 2021-08-03T21:14:45Z

src/quicklook.cs

+ {
+ }
+
+ [iOS (15,0), MacCatalyst (15,0)]


Mac ?

without a [Mac] it means the oldest supported (10,9) has it available.

Same for watchOS and tvOS. You likely want [NoWatch, NoTV, NoMac] if it's not available on macOS.

if there's no indication on the diffs, xtro, web docs, or header files - I tend to leave the availability of unmentioned platforms as is. But is it best to assume that there is no availability on those platforms? Since it's a breaking change to remove things, and it's always easier to introduce things later on?

But is it best to assume that there is no availability on those platforms?

No. Lack of availability attributes means it's been available since our earliest supported versions.
E.g. lack of [NoWatch] implies it's [Watch (2,0)] and that the API has been available in the past 6 years (or so)

This is almost always wrong when adding bindings for a new Xcode (unless it added a new platform).

Since it's a breaking change to remove things, and it's always easier to introduce things later on?

True :-) However it's true for code that we ship (post generation), not the binding sources!

Example: [NoWatch] -> means we're not generating the API on watchOS.

If you don't add [NoWatch] (in binding sources) then the API will be present inside Xamarin.WatchOS.dll (and assumed to be available since 2.0 which is watchOS minimum supported version).

If you want to fix that later, by adding [NoWatch], then you are creating a breaking change (since the API won't be part of Xamarin.WatchOS.dll in the next release).

Ah, I think my question was a bit confusing! I understand what you explained about the lack of availability attributes in our code - I meant instead to ask about how we should interpret the lack of mention of platform availability in diffs, xtro, web docs, and header files.

So in this case, there is no Watch availability or unavailability mentioned whatsoever in the diffs, xtro, web docs, or header files for this API. So I was asking if that means it's best to assume there's no watch availability and tag as [NoWatch] - does that make sense?

Short answer: Whenever in doubt it's better to assume [No*] if availability is not mentioned because it means no code will be generated (and it won't be a breaking change to add it later).

When you add (or modify) sharpie's output then it's good to add comments (for reviewers and people who will update the bindings... years later), e.g.

[NoWatch][NoTV][NoMac] // availability not mentioned in the header files

Long answer

Apple's macro are often incomplete or incorrect (e.g. wrong version)

Some (not all) gets fixed in newer betas or the next Xcode...

There are assumptions like

old (pre 9.0) iOS API are assumed to be available on tvOS 9 (first version) unless decorated otherwise

old (pre 13) iOS API are assumed to be available on MacCatalyst 13 (first version) ...

enums are not always decorated since they are not API (you can see which API uses them to know which attributes are needed)

Intro (runtime) and xtro (build time) will spot many, but not all, errors

over time you get to know the API/framework and can identify things that looks unusual (and add tests to confirm your gut feelings)

perfect, thank you!!!

dalexsoto

Nice!!

dalexsoto · 2021-08-03T21:15:20Z

src/quicklook.cs

+ interface QLFilePreviewRequest
+ {
+ [Export ("fileURL")]
+ NSUrl FileURL { get; }


Suggested change

NSUrl FileURL { get; }

NSUrl FileUrl { get; }

mandel-macaque

Bravo, approving taking into account sebs comments.

vs-mobiletools-engineering-service2 · 2021-08-04T00:56:22Z

❌ [PR Build] Tests failed on Build ❌

Tests failed on Build.

API diff

✅ API Diff from stable

View API diff

iOS vsdrops gist
macOS vsdrops gist
macCat vsdrops gist
macCatiOS gist
tvOS vsdrops gist
watchOS vsdrops gist

API & Generator diff

ℹ️ API Diff (from PR only) (please review changes)
ℹ️ Generator Diff (please review changes)

GitHub pages

Results can be found in the following github pages (it might take some time to publish):

Test results

1 tests failed, 91 tests passed.

Failed tests

monotouch-test/Mac Catalyst/Debug [dotnet]: Failed (Tests run: 2629 Passed: 2490 Inconclusive: 35 Failed: 1 Ignored: 138)

Pipeline on Agent XAMBOT-1094.BigSur'
Merge 6adb0c5 into 4aa51ba

vs-mobiletools-engineering-service2 · 2021-08-05T19:05:29Z

❌ [PR Build] Tests failed on Build ❌

Tests failed on Build.

API diff

✅ API Diff from stable

View API diff

iOS vsdrops gist
macOS vsdrops gist
macCat vsdrops gist
macCatiOS gist
tvOS vsdrops gist
watchOS vsdrops gist

API & Generator diff

ℹ️ API Diff (from PR only) (please review changes)
ℹ️ Generator Diff (please review changes)

GitHub pages

Results can be found in the following github pages (it might take some time to publish):

Test results

1 tests failed, 91 tests passed.

Failed tests

Generator tests/.NET: Failed (Execution failed with exit code 1)

Pipeline on Agent XAMBOT-1096.BigSur'
Merge 75ac7eb into 0ffed97

spouliot · 2021-08-06T15:17:46Z

@rachelkang it works locally for me and, if it was related to the generator change it should have failed in the non-botnet execution too. It would also have failed on the previous commits.

Logs shows

12:22:05.2558270   Failed NoWarn(macOSMobile) [12 s]
12:22:05.2558370   Error Message:
12:22:05.2558470    System.NullReferenceException : Object reference not set to an instance of an object.
12:22:05.2558570   Stack Trace:
12:22:05.2558660      at Xamarin.Tests.ThreadStaticTextWriter.WriteLine(String value) in /Users/builder/azdo/_work/1/s/xamarin-macios/tests/generator/BGenTool.cs:line 478
12:22:05.2558760    at System.IO.TextWriter.SyncTextWriter.WriteLine(Object value) in System.Private.CoreLib.dll:token 0x6005fe5+0x0
12:22:05.2558870    at System.Console.WriteLine(Object value) in System.Console.dll:token 0x6000082+0xb
12:22:05.2558970    at Xamarin.Tests.BGenTool.Execute() in /Users/builder/azdo/_work/1/s/xamarin-macios/tests/generator/BGenTool.cs:line 235
12:22:05.2559090    at Xamarin.Tests.BGenTool.AssertExecute(String message) in /Users/builder/azdo/_work/1/s/xamarin-macios/tests/generator/BGenTool.cs:line 207
12:22:05.2559320    at GeneratorTests.ErrorTests.NoWarn(Profile profile) in /Users/builder/azdo/_work/1/s/xamarin-macios/tests/generator/ErrorTests.cs:line 868

which is not in your code (but the test code) so it looks like a very uncommon random failure.

I file it inside maccore https://github.com/xamarin/maccore/issues/2489

You proceed with the merge!

rachelkang · 2021-08-06T16:26:57Z

@rachelkang it works locally for me and, if it was related to the generator change it should have failed in the non-botnet execution too. It would also have failed on the previous commits.

Logs shows

12:22:05.2558270   Failed NoWarn(macOSMobile) [12 s]
12:22:05.2558370   Error Message:
12:22:05.2558470    System.NullReferenceException : Object reference not set to an instance of an object.
12:22:05.2558570   Stack Trace:
12:22:05.2558660      at Xamarin.Tests.ThreadStaticTextWriter.WriteLine(String value) in /Users/builder/azdo/_work/1/s/xamarin-macios/tests/generator/BGenTool.cs:line 478
12:22:05.2558760    at System.IO.TextWriter.SyncTextWriter.WriteLine(Object value) in System.Private.CoreLib.dll:token 0x6005fe5+0x0
12:22:05.2558870    at System.Console.WriteLine(Object value) in System.Console.dll:token 0x6000082+0xb
12:22:05.2558970    at Xamarin.Tests.BGenTool.Execute() in /Users/builder/azdo/_work/1/s/xamarin-macios/tests/generator/BGenTool.cs:line 235
12:22:05.2559090    at Xamarin.Tests.BGenTool.AssertExecute(String message) in /Users/builder/azdo/_work/1/s/xamarin-macios/tests/generator/BGenTool.cs:line 207
12:22:05.2559320    at GeneratorTests.ErrorTests.NoWarn(Profile profile) in /Users/builder/azdo/_work/1/s/xamarin-macios/tests/generator/ErrorTests.cs:line 868

which is not in your code (but the test code) so it looks like a very uncommon random failure.

I file it inside maccore xamarin/maccore#2489

You proceed with the merge!

awesome, thank you!!!

[QuickLook] Update bindings for Xcode 13.0 beta 1,2,3,4

75b150e

rachelkang added the note-highlight Worth calling out specifically in release notes label Aug 3, 2021

rachelkang added this to the xcode13.0 milestone Aug 3, 2021

rachelkang requested review from dalexsoto and spouliot August 3, 2021 20:40

rachelkang commented Aug 3, 2021

View reviewed changes

Update catalyst availability of API to be introduced

6adb0c5

spouliot suggested changes Aug 3, 2021

View reviewed changes

dalexsoto approved these changes Aug 3, 2021

View reviewed changes

mandel-macaque approved these changes Aug 3, 2021

View reviewed changes

rolfbjarne approved these changes Aug 4, 2021

View reviewed changes

rachelkang added 2 commits August 5, 2021 10:03

Merge branch 'main' into xcode13.0-quicklook-b1-b2-b3-b4

5b72769

Update based on feedback

cae72a9

spouliot approved these changes Aug 5, 2021

View reviewed changes

Add comment about NoPlatform availabilities

75ac7eb

rachelkang merged commit e45969f into xamarin:main Aug 6, 2021

rachelkang mentioned this pull request Aug 9, 2021

[QuickLookUI] Update bindings for Xcode 13.0 beta 1 #12389

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[QuickLook] Update bindings for Xcode 13.0 beta 1,2,3,4 #12337

[QuickLook] Update bindings for Xcode 13.0 beta 1,2,3,4 #12337

rachelkang commented Aug 3, 2021

rachelkang Aug 3, 2021

spouliot Aug 3, 2021

rachelkang Aug 5, 2021

spouliot Aug 5, 2021

rachelkang Aug 5, 2021 •

edited

Loading

spouliot Aug 5, 2021

rachelkang Aug 5, 2021

dalexsoto left a comment

dalexsoto Aug 3, 2021

mandel-macaque left a comment

vs-mobiletools-engineering-service2 commented Aug 4, 2021

Failed tests

vs-mobiletools-engineering-service2 commented Aug 5, 2021

Failed tests

spouliot commented Aug 6, 2021

rachelkang commented Aug 6, 2021

[QuickLook] Update bindings for Xcode 13.0 beta 1,2,3,4 #12337

[QuickLook] Update bindings for Xcode 13.0 beta 1,2,3,4 #12337

Conversation

rachelkang commented Aug 3, 2021

rachelkang Aug 3, 2021

Choose a reason for hiding this comment

spouliot Aug 3, 2021

Choose a reason for hiding this comment

rachelkang Aug 5, 2021

Choose a reason for hiding this comment

spouliot Aug 5, 2021

Choose a reason for hiding this comment

rachelkang Aug 5, 2021 • edited Loading

Choose a reason for hiding this comment

spouliot Aug 5, 2021

Choose a reason for hiding this comment

rachelkang Aug 5, 2021

Choose a reason for hiding this comment

dalexsoto left a comment

Choose a reason for hiding this comment

dalexsoto Aug 3, 2021

Choose a reason for hiding this comment

mandel-macaque left a comment

Choose a reason for hiding this comment

vs-mobiletools-engineering-service2 commented Aug 4, 2021

❌ [PR Build] Tests failed on Build ❌

API diff

API & Generator diff

GitHub pages

Test results

Failed tests

vs-mobiletools-engineering-service2 commented Aug 5, 2021

❌ [PR Build] Tests failed on Build ❌

API diff

API & Generator diff

GitHub pages

Test results

Failed tests

spouliot commented Aug 6, 2021

rachelkang commented Aug 6, 2021

rachelkang Aug 5, 2021 •

edited

Loading